<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Structs  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a title="Structs  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">Hedwig Docs</a> (100% documented)</p>
        <p class="header-right"><a href="https://github.com/onevcat/Hedwig"><img src="img/gh.png"/>View on GitHub</a></p>
        <p class="header-right"><a href="dash-feed://https%3A%2F%2Fonevcat%2Egithub%2Eio%2FHedwig%2Fdocsets%2FHedwig%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">Hedwig Reference</a>
        <img id="carat" src="img/carat.png" />
        Structs  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Classes/SMTP.html">SMTP</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SMTP/Validation.html">– Validation</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SMTP/SMTPError.html">– SMTPError</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SMTP/Secure.html">– Secure</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SMTP/AuthMethod.html">– AuthMethod</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Enums.html">Enums</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/MailError.html">MailError</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Structs.html">Structs</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Structs/Attachment.html">Attachment</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Attachment/FileProperty.html">– FileProperty</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Attachment/HTMLProperty.html">– HTMLProperty</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Attachment/DataProperty.html">– DataProperty</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Attachment/AttachmentType.html">– AttachmentType</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Hedwig.html">Hedwig</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Mail.html">Mail</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/NameAddressPair.html">NameAddressPair</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Typealiases.html">Typealiases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:6Hedwig4Port">Port</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Structs</h1>
            <p>The following structs are available globally.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:V6Hedwig10Attachment"></a>
                    <a name="//apple_ref/swift/Struct/Attachment" class="dashAnchor"></a>
                    <a class="token" href="#/s:V6Hedwig10Attachment">Attachment</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Presentation an attachement contained in a <code><a href="Structs/Mail.html">Mail</a></code>.</p>

                        <a href="Structs/Attachment.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Attachment</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Hedwig/tree/1.1.0/Sources/Attachment.swift#L31-L270">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:V6Hedwig6Hedwig"></a>
                    <a name="//apple_ref/swift/Struct/Hedwig" class="dashAnchor"></a>
                    <a class="token" href="#/s:V6Hedwig6Hedwig">Hedwig</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Hedwig is the manager type of Hedwig framework. You can initialize an 
instance with common SMTP config and then send an email with it.</p>

                        <a href="Structs/Hedwig.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Hedwig</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Hedwig/tree/1.1.0/Sources/Hedwig.swift#L35-L142">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:V6Hedwig4Mail"></a>
                    <a name="//apple_ref/swift/Struct/Mail" class="dashAnchor"></a>
                    <a class="token" href="#/s:V6Hedwig4Mail">Mail</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Represents an email. It contains necessary information like <code>from</code>, <code>to</code> and
<code>text</code> with which Hedwig could send it with a connection to some SMTP server.
The whole type is immutable. You need to create a mail through the initialzer
and then feed it to a <code><a href="Structs/Hedwig.html">Hedwig</a></code> instance to send.</p>

                        <a href="Structs/Mail.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Mail</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Hedwig/tree/1.1.0/Sources/Mail.swift#L47-L143">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:V6Hedwig15NameAddressPair"></a>
                    <a name="//apple_ref/swift/Struct/NameAddressPair" class="dashAnchor"></a>
                    <a class="token" href="#/s:V6Hedwig15NameAddressPair">NameAddressPair</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Name and address used in mail <q>From</q>, <q>To</q>, <q>Cc</q> and <q>Bcc</q> fields.</p>

                        <a href="Structs/NameAddressPair.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">NameAddressPair</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/onevcat/Hedwig/tree/1.1.0/Sources/Mail.swift#L180-L205">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2017 <a class="link" href="https://onev.cat" target="_blank" rel="external">Wei</a>. All rights reserved. (Last updated: 2017-06-03)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
